Annotate GtkTreeModelSort.new_with_model() appropriately
authorLutzLue <luemken@pre-sense.de>
Tue, 3 Dec 2019 15:36:42 +0000 (15:36 +0000)
committerEmmanuele Bassi <ebassi@gmail.com>
Tue, 3 Dec 2019 15:36:42 +0000 (15:36 +0000)
The new_with_model() method is a constructor, and it returns a GtkTreeModelSort
instance, even if the C API returns a GtkTreeModel for the convenience of C
developers.

Fixes: #1077
gtk/gtktreemodelsort.c

index 2e3b808e75c127e41490280541043429cd345fe1..75476bad4b4a0af3960c008b57c2222cb9dec961 100644 (file)
@@ -526,12 +526,12 @@ gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface)
 }
 
 /**
- * gtk_tree_model_sort_new_with_model:
+ * gtk_tree_model_sort_new_with_model: (constructor)
  * @child_model: A #GtkTreeModel
  *
- * Creates a new #GtkTreeModel, with @child_model as the child model.
+ * Creates a new #GtkTreeModelSort, with @child_model as the child model.
  *
- * Returns: (transfer full): A new #GtkTreeModel.
+ * Returns: (transfer full) (type Gtk.TreeModelSort): A new #GtkTreeModelSort.
  */
 GtkTreeModel *
 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)